/*
 * $Id: TkTmApi.c,v 1.1.2.2 Broadcom SDK $
 * $Copyright: Copyright 2011 Broadcom Corporation.
 * This program is the proprietary software of Broadcom Corporation
 * and/or its licensors, and may only be used, duplicated, modified
 * or distributed pursuant to the terms and conditions of a separate,
 * written license agreement executed between you and Broadcom
 * (an "Authorized License").  Except as set forth in an Authorized
 * License, Broadcom grants no license (express or implied), right
 * to use, or waiver of any kind with respect to the Software, and
 * Broadcom expressly reserves all rights in and to the Software
 * and all intellectual property rights therein.  IF YOU HAVE
 * NO AUTHORIZED LICENSE, THEN YOU HAVE NO RIGHT TO USE THIS SOFTWARE
 * IN ANY WAY, AND SHOULD IMMEDIATELY NOTIFY BROADCOM AND DISCONTINUE
 * ALL USE OF THE SOFTWARE.  
 *  
 * Except as expressly set forth in the Authorized License,
 *  
 * 1.     This program, including its structure, sequence and organization,
 * constitutes the valuable trade secrets of Broadcom, and you shall use
 * all reasonable efforts to protect the confidentiality thereof,
 * and to use this information only in connection with your use of
 * Broadcom integrated circuit products.
 *  
 * 2.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS
 * PROVIDED "AS IS" AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES,
 * REPRESENTATIONS OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY,
 * OR OTHERWISE, WITH RESPECT TO THE SOFTWARE.  BROADCOM SPECIFICALLY
 * DISCLAIMS ANY AND ALL IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY,
 * NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF VIRUSES,
 * ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
 * CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING
 * OUT OF USE OR PERFORMANCE OF THE SOFTWARE.
 * 
 * 3.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL
 * BROADCOM OR ITS LICENSORS BE LIABLE FOR (i) CONSEQUENTIAL,
 * INCIDENTAL, SPECIAL, INDIRECT, OR EXEMPLARY DAMAGES WHATSOEVER
 * ARISING OUT OF OR IN ANY WAY RELATING TO YOUR USE OF OR INABILITY
 * TO USE THE SOFTWARE EVEN IF BROADCOM HAS BEEN ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES; OR (ii) ANY AMOUNT IN EXCESS OF
 * THE AMOUNT ACTUALLY PAID FOR THE SOFTWARE ITSELF OR USD 1.00,
 * WHICHEVER IS GREATER. THESE LIMITATIONS SHALL APPLY NOTWITHSTANDING
 * ANY FAILURE OF ESSENTIAL PURPOSE OF ANY LIMITED REMEDY.$
 *
 * File:     TkTmApi.c
 * Purpose: 
 *
 */

#include <soc/ea/TkTypes.h>
#include <soc/ea/Oam.h>
#include <soc/ea/OamUtils.h>
#include <soc/ea/TkTmApi.h>
#include <soc/ea/TkDebug.h>

/*
 * send TK extension OAM message Get queue configuration from the ONU 
 */
int
TkExtOamGetQueueCfg(uint8 pathId, uint8 LinkId, uint8 * pQueueCfg)
{
    uint32          DataLen;

    if ((LinkId > 7) || (NULL == pQueueCfg)) {
        TkDbgTrace(TkDbgErrorEnable);
        return ERROR;
    }

    if (OK ==
        TkExtOamGet(pathId, LinkId,
                    OamBranchAction,
                    OamExtActGetQueueConfig, (uint8 *) pQueueCfg,
                    &DataLen)) {
        return (OK);
    } else {
        TkDbgTrace(TkDbgErrorEnable);
        return ERROR;
    }
}


/*
 * send TK extension OAM message Set enable user traffic to the ONU 
 */
uint8
TkExtOamSetEnaUserTraffic(uint8 pathId, uint8 LinkId)
{
    if (LinkId > 7)
        return (OamVarErrActBadParameters);

    return (TkExtOamSet
            (pathId, LinkId, OamBranchAction,
             OamExtActOnuEnableUserTraffic, NULL, 0));
}


/*
 * send TK extension OAM message Set disable user traffic to the ONU 
 */
uint8
TkExtOamSetDisUserTraffic(uint8 pathId, uint8 LinkId)
{
    if (LinkId > 7)
        return (OamVarErrActBadParameters);

    return (TkExtOamSet
            (pathId, LinkId, OamBranchAction,
             OamExtActOnuDisableUserTraffic, NULL, 0));
}

/*
 * send TK extension OAM message Get BcastRateLimit ON/OFF 
 */
int
TkExtOamGetBcastRateLimit(uint8 pathId, uint8 LinkId, Bool * Status)
{
    uint32          DataLen;

    if ((LinkId > 7)) {
        TkDbgTrace(TkDbgErrorEnable);
        return ERROR;
    }

    if (OK ==
        TkExtOamGet(pathId, LinkId,
                    OamBranchAttribute,
                    OamExtAttrBcastRateLimit, (uint8 *) Status, &DataLen))
        return (OK);
    else {
        TkDbgTrace(TkDbgErrorEnable);
        return ERROR;
    }
}

/*
 * send TK extension OAM message Set BcastRateLimit ON/OFF
 */
uint8
TkExtOamSetBcastRateLimit(uint8 pathId, uint8 LinkId, Bool Status)
{

    if ((LinkId > 7))
        return (OamVarErrActBadParameters);

    return (TkExtOamSet
            (pathId, LinkId, OamBranchAttribute,
             OamExtAttrBcastRateLimit, (Bool *) & Status, sizeof(Bool)));
}
